Server Watch Plugin SDK Date: 6 Feb 2004
Release: 1.0
Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

SWHandle Class Reference

#include <SWHandle.h>

List of all members.


Detailed Description

This class represents a globally unique identifier.

Instances of this class are used to uniquely identify objects from one another. A plugin user is unlikely to need to create or use instances of SWHandle, but it will be seen heavily throughout the framework and may appear in demo plugins.

GUID String Format:
SWHandle uses a specific GUID format string similar to that used in Windows. All character strings that are used with SWHandles should Conform to this format:
     XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Where 'X' can be either a letter or number and '-' must be a hyphen.


Public Member Functions

Constructors/Destructors
SWHandle can be created from scratch or by passing another SWHandle into the constructor or passing a buffer of wchar_t or char that is compatible with the GUID format used by SWHandle into the constructor.

 SWHandle ()
 Standard Constructor Internal GUID is generated automatically.
 SWHandle (const wchar_t *foo)
 Constructor Creates internal GUID from the string that was passed in.
 SWHandle (const char *foo)
 Constructor Creates internal GUID from the string that was passed in.
 SWHandle (const SWHandle &toCopy)
 Copy Constructor Created as a copy of the passed in SWHandle.
virtual ~SWHandle ()
Equal Operators
SWHandle can be set equal to another SWHandle or to number of different types. The strings must comform to the GUID format used by SWHandle

SWHandle operator= (const CAtlString &foo)
SWHandle operator= (const std::wstring &foo)
SWHandle operator= (const wchar_t *foo)
SWHandle operator= (const char *foo)
SWHandle operator= (const SWHandle &foo)
Conversion Operations
The internal string representation of the SWHandle GUID can be retrieved as a character string.

 operator const char * () const
const char * toCharString () const

Friends

SWSERVICES_API bool operator== (const SWHandle &s1, const SWHandle &toCompare)
SWSERVICES_API bool operator== (const SWHandle &s1, const CAtlString &toCompare)
SWSERVICES_API bool operator== (const SWHandle &s1, const std::wstring &toCompare)
SWSERVICES_API bool operator== (const SWHandle &s1, const wchar_t *foo)
SWSERVICES_API bool operator== (const SWHandle &s1, const char *foo)
SWSERVICES_API bool operator!= (const SWHandle &s1, const SWHandle &toCompare)
SWSERVICES_API bool operator!= (const SWHandle &s1, const CAtlString &toCompare)
SWSERVICES_API bool operator!= (const SWHandle &s1, const std::wstring &toCompare)
SWSERVICES_API bool operator!= (const SWHandle &s1, const wchar_t *foo)
SWSERVICES_API bool operator!= (const SWHandle &s1, const char *foo)
SWSERVICES_API bool operator< (const SWHandle &s1, const SWHandle &toCompare)
SWSERVICES_API bool operator< (const SWHandle &s1, const CAtlString &toCompare)
SWSERVICES_API bool operator< (const SWHandle &s1, const std::wstring &toCompare)
SWSERVICES_API bool operator< (const SWHandle &s1, const wchar_t *foo)
SWSERVICES_API bool operator< (const SWHandle &s1, const char *foo)
SWSERVICES_API bool operator<= (const SWHandle &s1, const SWHandle &toCompare)
SWSERVICES_API bool operator<= (const SWHandle &s1, const CAtlString &toCompare)
SWSERVICES_API bool operator<= (const SWHandle &s1, const std::wstring &toCompare)
SWSERVICES_API bool operator<= (const SWHandle &s1, const wchar_t *foo)
SWSERVICES_API bool operator<= (const SWHandle &s1, const char *foo)
SWSERVICES_API bool operator> (const SWHandle &s1, const SWHandle &toCompare)
SWSERVICES_API bool operator> (const SWHandle &s1, const CAtlString &toCompare)
SWSERVICES_API bool operator> (const SWHandle &s1, const std::wstring &toCompare)
SWSERVICES_API bool operator> (const SWHandle &s1, const wchar_t *foo)
SWSERVICES_API bool operator> (const SWHandle &s1, const char *foo)
SWSERVICES_API bool operator>= (const SWHandle &s1, const SWHandle &toCompare)
SWSERVICES_API bool operator>= (const SWHandle &s1, const CAtlString &toCompare)
SWSERVICES_API bool operator>= (const SWHandle &s1, const std::wstring &toCompare)
SWSERVICES_API bool operator>= (const SWHandle &s1, const wchar_t *foo)
SWSERVICES_API bool operator>= (const SWHandle &s1, const char *foo)
SWSERVICES_API std::ostream & operator<< (std::ostream &os, SWHandle &handle)
SWSERVICES_API std::stringstream & operator<< (std::stringstream &os, SWHandle &handle)
SWSERVICES_API std::wstringstream & operator<< (std::wstringstream &os, SWHandle &handle)


Constructor & Destructor Documentation

SWHandle::SWHandle  ) 
 

Standard Constructor Internal GUID is generated automatically.

SWHandle::SWHandle const wchar_t *  foo  ) 
 

Constructor Creates internal GUID from the string that was passed in.

SWHandle::SWHandle const char *  foo  ) 
 

Constructor Creates internal GUID from the string that was passed in.

SWHandle::SWHandle const SWHandle toCopy  ) 
 

Copy Constructor Created as a copy of the passed in SWHandle.

virtual SWHandle::~SWHandle  )  [virtual]
 

Destructor


Member Function Documentation

SWHandle SWHandle::operator= const CAtlString &  foo  ) 
 

Sets the internal GUID based on the string that was passed in.

SWHandle SWHandle::operator= const std::wstring &  foo  ) 
 

Sets the internal GUID based on the string that was passed in.

SWHandle SWHandle::operator= const wchar_t *  foo  ) 
 

Sets the internal GUID based on the string that was passed in.

SWHandle SWHandle::operator= const char *  foo  ) 
 

Sets the internal GUID based on the string that was passed in.

SWHandle SWHandle::operator= const SWHandle foo  ) 
 

Sets the internal GUID based on the SWHandle that was passed in.

SWHandle::operator const char *  )  const
 

Returns a pointer to the internal GUID

const char* SWHandle::toCharString  )  const
 

Returns a pointer to the internal GUID


Friends And Related Function Documentation

SWSERVICES_API bool operator== const SWHandle s1,
const SWHandle toCompare
[friend]
 

Compares two SWHandles for equality

SWSERVICES_API bool operator== const SWHandle s1,
const CAtlString &  toCompare
[friend]
 

Compares an SWHandle and a string for equality

SWSERVICES_API bool operator== const SWHandle s1,
const std::wstring &  toCompare
[friend]
 

Compares an SWHandle and a string for equality

SWSERVICES_API bool operator== const SWHandle s1,
const wchar_t *  foo
[friend]
 

Compares an SWHandle and a string for equality

SWSERVICES_API bool operator== const SWHandle s1,
const char *  foo
[friend]
 

Compares an SWHandle and a string for equality

SWSERVICES_API bool operator!= const SWHandle s1,
const SWHandle toCompare
[friend]
 

Compares two SWHandles for inequality

SWSERVICES_API bool operator!= const SWHandle s1,
const CAtlString &  toCompare
[friend]
 

Compares an SWHandle and a string for inequality

SWSERVICES_API bool operator!= const SWHandle s1,
const std::wstring &  toCompare
[friend]
 

Compares an SWHandle and a string for inequality

SWSERVICES_API bool operator!= const SWHandle s1,
const wchar_t *  foo
[friend]
 

Compares an SWHandle and a string for inequality

SWSERVICES_API bool operator!= const SWHandle s1,
const char *  foo
[friend]
 

Compares an SWHandle and a string for inequality

SWSERVICES_API bool operator< const SWHandle s1,
const SWHandle toCompare
[friend]
 

Compares two SWHandles to see if the first is less than the second

SWSERVICES_API bool operator< const SWHandle s1,
const CAtlString &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second

SWSERVICES_API bool operator< const SWHandle s1,
const std::wstring &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second

SWSERVICES_API bool operator< const SWHandle s1,
const wchar_t *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second

SWSERVICES_API bool operator< const SWHandle s1,
const char *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second

SWSERVICES_API bool operator<= const SWHandle s1,
const SWHandle toCompare
[friend]
 

Compares two SWHandles to see if the first is less than the second or if they are equal

SWSERVICES_API bool operator<= const SWHandle s1,
const CAtlString &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second or if they are equal

SWSERVICES_API bool operator<= const SWHandle s1,
const std::wstring &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second or if they are equal

SWSERVICES_API bool operator<= const SWHandle s1,
const wchar_t *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second or if they are equal

SWSERVICES_API bool operator<= const SWHandle s1,
const char *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is less than the second or if they are equal

SWSERVICES_API bool operator> const SWHandle s1,
const SWHandle toCompare
[friend]
 

Compares two SWHandles to see if the first is greater than the second

SWSERVICES_API bool operator> const SWHandle s1,
const CAtlString &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second

SWSERVICES_API bool operator> const SWHandle s1,
const std::wstring &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second

SWSERVICES_API bool operator> const SWHandle s1,
const wchar_t *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second

SWSERVICES_API bool operator> const SWHandle s1,
const char *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second

SWSERVICES_API bool operator>= const SWHandle s1,
const SWHandle toCompare
[friend]
 

Compares two SWHandles to see if the first is greater than the second or if they are equal

SWSERVICES_API bool operator>= const SWHandle s1,
const CAtlString &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second or if they are equal

SWSERVICES_API bool operator>= const SWHandle s1,
const std::wstring &  toCompare
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second or if they are equal

SWSERVICES_API bool operator>= const SWHandle s1,
const wchar_t *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second or if they are equal

SWSERVICES_API bool operator>= const SWHandle s1,
const char *  foo
[friend]
 

Compares an SWHandle and a string to see if the first is greater than the second or if they are equal

SWSERVICES_API std::ostream& operator<< std::ostream &  os,
SWHandle handle
[friend]
 

Streams an SWHandle into an ostream

SWSERVICES_API std::stringstream& operator<< std::stringstream &  os,
SWHandle handle
[friend]
 

Streams an SWHandle into a stringstream

SWSERVICES_API std::wstringstream& operator<< std::wstringstream &  os,
SWHandle handle
[friend]
 

Streams an SWHandle into a wstringstream


The documentation for this class was generated from the following file:

Copyright (c) 2003-2004, Deep Fried Software. All rights reserved.